emida-ux

1.0.x
(0 reviews)

eSim plan or Addon provisioning

/productOrder

[POST]

This usecase to create the product ordering for Plans and AddOns.

URL
https://[localhost]:[port]/emida-ux-lcr/emida-ux/v1/{businessId}/productOrder
URI Params
nametypedescriptionrequired
businessIdstringDefault CR for Costa RicaY
Headers
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.		Y
Body
Definitions - DataPlan
NameTypeDescriptionRequired
categoryStringDefines the category of the product order. default = esimPrepaidY
productOrderItem[].idStringIndicates the count of order item. default = 1N
productOrderItem[].actionStringIndicates the action to be performed for order item. default = addN
productOrderItem[].product.isBundleBooleanIndicates whether the product is a bundle (true or false).N
productOrderItem[].product.@typeStringType of the related product. Default: Product.N
productOrderItem[].product.productOffering.idStringIndicates the offer id. example: OFFER-DP-001.Y
productOrderItem[].product.productCharacteristic[].nameStringName of the product characteristic. Default: MSISDN.Y
productOrderItem[].product.productCharacteristic[].valueStringmsisdn number to initiate the provisioningY
productOrderItem[].product.productCharacteristic[].nameStringName of the product characteristic. Default: planType.Y
productOrderItem[].product.productCharacteristic[].valueStringType of offer for product provisioning (Dataplan).Y
relatedParty[].idStringreseller Id for the provisioning.N
relatedParty[].roleStringRole for the reseller. Default: Seller.N
relatedParty[].@referredTypeStringType of the related party. Default: Individual.N
relatedParty[].idStringIdenitification value of the customer. example: 900770050N
relatedParty[].nameStringFull name of the customer. example: Juan;Carlos;Perez;Gonzalez.N
relatedParty[].roleStringRole of the related name. Default: Customer.N
relatedParty[].characteristic[].nameStringIdentification type of the customer. Default:identificationTypeN
relatedParty[].characteristic[].valueTypeStringDataType of the IdentificationType. Default: String.N
relatedParty[].characteristic[].valueStringvalue for the Identification Type. example: PassportN
relatedParty[].@referredTypeStringType of the related party. Default: Individual.N
Definitions - Plan
NameTypeDescriptionRequired
categoryStringDefines the category of the product order. default = esimPrepaidY
productOrderItem[].idStringIndicates the count of order item. default = 1N
productOrderItem[].actionStringIndicates the action to be performed for order item. default = addN
productOrderItem[].product.isBundleBooleanIndicates whether the product is a bundle (true or false).N
productOrderItem[].product.@typeStringType of the related product. Default: Product.N
productOrderItem[].product.productOffering.idStringIndicates the offer id. example: OFFER-DP-001.Y
productOrderItem[].product.productCharacteristic[].nameStringName of the product characteristic. Default: MSISDN.Y
productOrderItem[].product.productCharacteristic[].valueStringmsisdn number to initiate the provisioningY
productOrderItem[].product.productCharacteristic[].nameStringName of the product characteristic. Default: planType.Y
productOrderItem[].product.productCharacteristic[].valueStringType of offer for product provisioning (Plan).Y
relatedParty[].idStringreseller Id for the provisioning.N
relatedParty[].roleStringRole for the reseller. Default: Seller.N
relatedParty[].@referredTypeStringType of the related party. Default: Individual.N
relatedParty[].idStringIdenitification value of the customer. example: 900770050N
relatedParty[].nameStringFull name of the customer. example: Juan;Carlos;Perez;Gonzalez.N
relatedParty[].roleStringRole of the related name. Default: Customer.N
relatedParty[].characteristic[].nameStringIdentification type of the customer. Default:identificationTypeN
relatedParty[].characteristic[].valueTypeStringDataType of the IdentificationType. Default: String.N
relatedParty[].characteristic[].valueStringvalue for the Identification Type. example: PassportN
relatedParty[].@referredTypeStringType of the related party. Default: Individual.N
Definitions - Addon
NameTypeDescriptionRequired
categoryStringDefines the category of the product order. default = esimPrepaidY
productOrderItem[].idStringIndicates the count of order item. default = 1N
productOrderItem[].actionStringIndicates the action to be performed for order item. default = addN
productOrderItem[].product.isBundleBooleanIndicates whether the product is a bundle (true or false).N
productOrderItem[].product.@typeStringType of the related product. Default: Product.N
productOrderItem[].product.productOffering.idStringIndicates the offer id. example: OFFER-DP-001.Y
productOrderItem[].product.productCharacteristic[].nameStringName of the product characteristic. Default: MSISDN.Y
productOrderItem[].product.productCharacteristic[].valueStringmsisdn number to initiate the provisioningY
productOrderItem[].product.productCharacteristic[].nameStringName of the product characteristic. Default: planType.Y
productOrderItem[].product.productCharacteristic[].valueStringType of offer for product provisioning (Addon).Y
relatedParty[].idStringreseller Id for the provisioning.N
relatedParty[].roleStringRole for the reseller. Default: Seller.N
relatedParty[].@referredTypeStringType of the related party. Default: Individual.N
relatedParty[].idStringIdenitification value of the customer. example: 900770050N
relatedParty[].nameStringFull name of the customer. example: Juan;Carlos;Perez;Gonzalez.N
relatedParty[].roleStringRole of the related name. Default: Customer.N
relatedParty[].characteristic[].nameStringIdentification type of the customer. Default:identificationTypeN
relatedParty[].characteristic[].valueTypeStringDataType of the IdentificationType. Default: String.N
relatedParty[].characteristic[].valueStringvalue for the Identification Type. example: PassportN
relatedParty[].@referredTypeStringType of the related party. Default: Individual.N
cURL request - DataPlan
curl --location 'https://nonprod.lcr.esb.cloud.lla.com/dev/emida-ux-lcr/emida-ux/v1/CR/productOrder' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_secret: ******' \
--header 'client_id: ******' \
--header 'Content-Type: application/json' \
--data-raw '{
  "category": "esimPrepaid",
  "productOrderItem": [
    {
      "id": "1",
      "action": "add",
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productOffering": {
          "id": "OFFER-DP-001"
        },
        "productCharacteristic": [
          {
            "name": "MSISDN",
            "value": "69877689"
          },
          {
            "name": "planType",
            "value": "DataPlan"
          }
        ]
      }
    }
  ],
  "relatedParty": [
    {
      "id": "RESELLER-001",
      "role": "Seller",
      "@referredType": "Individual"
    },
    {
      "id": "900770050",
      "name": "Juan;Carlos;Perez;Gonzalez",
      "role": "Customer",
      "characteristic": [
        {
          "name": "identificationType",
          "valueType": "string",
          "value": "Passport"
        }],
      "@referredType": "Individual"
    }
  ]
}'
cURL request - DataPlan (without Customer information)
curl --location 'https://nonprod.lcr.esb.cloud.lla.com/dev/emida-ux-lcr/emida-ux/v1/CR/productOrder' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_secret: ******' \
--header 'client_id: ******' \
--header 'Content-Type: application/json' \
--data-raw '{
  "category": "esimPrepaid",
  "productOrderItem": [
    {
      "id": "1",
      "action": "add",
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productOffering": {
          "id": "OFFER-DP-001"
        },
        "productCharacteristic": [
          {
            "name": "MSISDN",
            "value": "69877689"
          },
          {
            "name": "planType",
            "value": "DataPlan"
          }
        ]
      }
    }
  ]
}'
cURL request - Plan
curl --location 'https://nonprod.lcr.esb.cloud.lla.com/dev/emida-ux-lcr/emida-ux/v1/CR/productOrder' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_secret: ******' \
--header 'client_id: ******' \
--header 'Content-Type: application/json' \
--data-raw '{
  "category": "esimPrepaid",
  "productOrderItem": [
    {
      "id": "1",
      "action": "add",
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productOffering": {
          "id": "OFFER-DP-001"
        },
        "productCharacteristic": [
          {
            "name": "MSISDN",
            "value": "69877689"
          },
          {
            "name": "planType",
            "value": "Plan"
          }
        ]
      }
    }
  ],
  "relatedParty": [
    {
      "id": "RESELLER-001",
      "role": "Seller",
      "@referredType": "Individual"
    },
    {
      "id": "900770050",
      "name": "Juan;Carlos;Perez;Gonzalez",
      "role": "Customer",
      "characteristic": [
        {
          "name": "identificationType",
          "valueType": "string",
          "value": "Passport"
        }],
      "@referredType": "Individual"
    }
  ]
}'
cURL request - Plan (without Customer information)
curl --location 'https://nonprod.lcr.esb.cloud.lla.com/dev/emida-ux-lcr/emida-ux/v1/CR/productOrder' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_secret: ******' \
--header 'client_id: ******' \
--header 'Content-Type: application/json' \
--data-raw '{
  "category": "esimPrepaid",
  "productOrderItem": [
    {
      "id": "1",
      "action": "add",
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productOffering": {
          "id": "OFFER-DP-001"
        },
        "productCharacteristic": [
          {
            "name": "MSISDN",
            "value": "69877689"
          },
          {
            "name": "planType",
            "value": "Plan"
          }
        ]
      }
    }
  ]
}'
cURL request - Addon
curl --location 'https://nonprod.lcr.esb.cloud.lla.com/dev/emida-ux-lcr/emida-ux/v1/CR/productOrder' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_secret: ******' \
--header 'client_id: ******' \
--header 'Content-Type: application/json' \
--data-raw '{
  "category": "esimPrepaid",
  "productOrderItem": [
    {
      "id": "1",
      "action": "add",
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productOffering": {
          "id": "OFFER-DP-001"
        },
        "productCharacteristic": [
          {
            "name": "MSISDN",
            "value": "69877689"
          },
          {
            "name": "planType",
            "value": "Addon"
          }
        ]
      }
    }
  ],
  "relatedParty": [
    {
      "id": "RESELLER-001",
      "role": "Seller",
      "@referredType": "Individual"
    },
    {
      "id": "900770050",
      "name": "Juan;Carlos;Perez;Gonzalez",
      "role": "Customer",
      "characteristic": [
        {
          "name": "identificationType",
          "valueType": "string",
          "value": "Passport"
        }],
      "@referredType": "Individual"
    }
  ]
}'
cURL request - Addon (without Customer information)
curl --location 'https://nonprod.lcr.esb.cloud.lla.com/dev/emida-ux-lcr/emida-ux/v1/CR/productOrder' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_secret: ******' \
--header 'client_id: ******' \
--header 'Content-Type: application/json' \
--data-raw '{
  "category": "esimPrepaid",
  "productOrderItem": [
    {
      "id": "1",
      "action": "add",
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productOffering": {
          "id": "OFFER-DP-001"
        },
        "productCharacteristic": [
          {
            "name": "MSISDN",
            "value": "69877689"
          },
          {
            "name": "planType",
            "value": "Addon"
          }
        ]
      }
    }
  ]
}'
Response
{
  "id": "ORD-20251208143025-5432",
  "category": "esimPrepaid",
  "orderDate": "2024-02-05T08:53:36.042-05:00",
  "state": "completed",
  "description": "Product provisioned successfully",
  "productOrderItem": [
    {
      "id": "1",
      "action": "add",
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productOffering": {
          "id": "OFFER-DP-001"
        },
        "productCharacteristic": [
          {
            "name": "MSISDN",
            "value": "69877689"
          }
        ]
      }
    }
  ]
}

Reviews